Installation to Add Adapter

Installation to Add Adapter to IAP (Optional)

IAP uses network and OSS adapters to facilitate the integration of IAP with various systems and applications.

In order to add a new adapter to IAP, the adapter module must be installed under node_modules within the IAP installation directory.

npm Package

The following steps demonstrate installing the adapter, from the npm registry and in its package form.

cd /opt/pronghorn/current

# Install "latest".
npm install @itentialopensource/adapter-db_mongo

# Install, or upgrade, a specific version.
npm install @itentialopensource/adapter-db_mongo@1.2.3

Source

Alternatively, an adapter may be installed from source.

cd /opt/pronghorn/current/node_modules/@itential
git clone git@gitlab.com:itentialopensource/adapters/persistence/adapter-db_mongo
cd adapter-db_mongo
npm ci

When you must upgrade, or change versions of an adapter, perform the following steps.

cd /opt/pronghorn/current/node_modules/@itential/adapter-db_mongo
git checkout master
git pull

# If you need to see a list of all the tags/version numbers: `git tag`.

git checkout <your desired version number>
git pull
rm -rf node_modules
npm ci

Once the adapter module is installed, restart IAP and the adapter will be auto-discovered during IAP startup and become available when adding an adapter via the IAP UI.

The following steps will add an available adapter to IAP.

1. Login to IAP and select Admin Essentials in the left navbar.

   Figure 1: IAP Homepage

   

2. Click the plus (+) sign in the top toolbar of the Admin Essentials application to open the Create dialog.

3. Select Adapter from the dropdown menu, enter the desired name of the adapter and select the type, and then click Save.

   Figure 2: Create Dialog

   

4. A skeleton JSON object of the Service Configuration for the adapter will be created and can be edited to match your environment by enabling the Service Config editor using the toggle switch (top-right).

   Figure 3: Configuration Properties

   

5. Click the Save button to retain your changes to the Service Config for your adapter.

   Figure 4: Save Service Configuration

   

6. The adapter will display under the Adapters menu in the left navbar, and from the Adapters collection view when you click the search icon (magnifying glass) in the top toolbar and select the Adapters tab.

   Figure 5: Adapters Collection View

   

Additional Information

• For more information on adapter integration, see the IAP Integrations section under the IAP Admin Guide.
• See the Itential Pre-Built Collection repository for all adapters that are available.
• Lastly, see the Adapters Technical Resources site for a library of information related to adapters.